Crate heck[−][src]
Expand description
heck is a case conversion library.
This library exists to provide case conversion between common cases like CamelCase and snake_case. It is intended to be unicode aware, internally, consistent, and reasonably well performing.
Definition of a word boundary
Word boundaries are defined as the “unicode words” defined in the
unicode_segmentation
library, as well as within those words in this
manner:
- All underscore characters are considered word boundaries.
- If an uppercase character is followed by lowercase letters, a word boundary is considered to be just prior to that uppercase character.
- If multiple uppercase characters are consecutive, they are considered to be within a single word, except that the last will be part of the next word if it is followed by lowercase characters (see rule 2).
That is, “HelloWorld” is segmented Hello|World
whereas “XMLHttpRequest” is
segmented XML|Http|Request
.
Characters not within words (such as spaces, punctuations, and underscores) are not included in the output string except as they are a part of the case being converted to. Multiple adjacent word boundaries (such as a series of underscores) are folded into one. (“hello__world” in snake case is therefore “hello_world”, not the exact same string). Leading or trailing word boundary indicators are dropped, except insofar as CamelCase capitalizes the first word.
Cases contained in this library:
- CamelCase
- snake_case
- kebab-case
- SHOUTY_SNAKE_CASE
- mixedCase
- Title Case
- SHOUTY-KEBAB-CASE
Traits
CamelCase | This trait defines a camel case conversion. |
KebabCase | This trait defines a kebab case conversion. |
MixedCase | This trait defines a mixed case conversion. |
ShoutyKebabCase | This trait defines a shouty kebab case conversion. |
ShoutySnakeCase | This trait defines a shouty snake case conversion. |
ShoutySnekCase | Oh heck, ShoutySnekCase is an alias for ShoutySnakeCase. See ShoutySnakeCase for more documentation. |
SnakeCase | This trait defines a snake case conversion. |
SnekCase | Oh heck, SnekCase is an alias for SnakeCase. See SnakeCase for more documentation. |
TitleCase | This trait defines a title case conversion. |